Skip to main content

Connect-Immich

SYNOPSIS​

Establishes connection to Immich server.

SYNTAX​

AccessToken​

Connect-Immich -BaseURL <String> [-AccessToken <String>] [-PassThru] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

Credentials​

Connect-Immich -BaseURL <String> [-Credential <PSCredential>] [-PassThru] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

DESCRIPTION​

Creates authenticated session using access token or credentials for API access.

EXAMPLES​

EXAMPLE 1​

Connect-Immich -BaseURL 'https://immich.example.com' -AccessToken 'your-token'

Connects using access token authentication.

EXAMPLE 2​

$session = Connect-Immich -BaseURL 'https://immich.example.com' -Credential (Get-Credential) -PassThru

Connects with credentials and returns session object.

-PassThru

EXAMPLE 3​

Connect-Immich -BaseURL 'https://immich.domain.com' -AccessToken 'ABoR54bB1NUc4aNY0F2PhppP1tVDu2Husr3vEbPUsw5'

Connect using access token

EXAMPLE 4​

Connect-Immich -BaseURL 'https://immich.domain.com' -Credentials (Get-Credential)

Connect using username and password

PARAMETERS​

-BaseURL​

Immich server URL (e.g., 'https://immich.example.com').

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-AccessToken​

API access token generated from Immich web interface.

Type: String
Parameter Sets: AccessToken
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Credential​

Username/password credentials as PSCredential object.

Type: PSCredential
Parameter Sets: Credentials
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PassThru​

Returns ImmichSession object for explicit session management.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction​

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters​

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS​

OUTPUTS​

NOTES​

EDIT THIS DOC​

This page was auto-generated from the powershell command comment based help. To edit the content of this page, update the script file comment based help on github Github